package com.jsftoolkit.base;

import java.util.List;
import java.util.Map;

import javax.faces.component.UIComponent;
import javax.faces.component.UIData;

import com.jsftoolkit.base.components.UIDataProcessor;

/**
 * Interface for components that do iteration in JSF, but might not be able to
 * extend {@link UIData}. Each method is expected to do just what it would in
 * UIData. Iteration starts at the index returned by {@link #getFirst()} and
 * ends after {@link #getRows()} have been processed or
 * {@link #isRowAvailable()} returns false.
 * <p>
 * This interface may be used with {@link UIDataProcessor}.
 * 
 * @author noah
 * 
 */
public interface JsfIterator extends ChildManager {

	int getRowIndex();

	int getFirst();

	int getRows();

	void setRowIndex(int rowIndex);

	boolean isRowAvailable();

	Map<String, UIComponent> getFacets();

	List<UIComponent> getChildren();

}
